home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr18 / nwt102a.zip / NWT.DOC < prev    next >
Text File  |  1995-01-08  |  23KB  |  451 lines

  1.  
  2. NewWadTool NWT v1.2a
  3. Copyright (c) 1/95 by Denis Möller, TiC, denis@doomsday.shnet.org
  4.  
  5. Documentation
  6.  
  7.  
  8. Introduction & Legal stuff
  9. --------------------------------------------------------------------------
  10.   Use NWT at  your own risk. The software  in this archive  is distributed
  11. "as is" without  warrenty of  any kind. The  author is not liable  for any
  12. direct or indirect damage caused as a result of using this program.
  13. The software is distributed as  Freeware. NO fee or payment may be charged
  14. for this program. You are not allowed to change the program.
  15.  
  16.   Doom & Doom 2 are trademarks of id software - of course :)
  17.   Heretic was developed by Raven Software for id Software
  18.   Rise Of The Triad by Apogee
  19.   DEU is written by Raphaël Quinet & Brendon J Wyber.
  20.   DeuTex & DeuSF are written by Olivier Montanuy.
  21.   Dmaud & Dmgraph are written by Bill Neisius.
  22.   Dmadds/f are written by Bernd Kreimeier.
  23.  
  24.  
  25. Credits
  26. --------------------------------------------------------------------------
  27.  Thanks to
  28.   - id software, raven software
  29.   - Raphaël Quinet & Brendon J Wyber for the great editor utility
  30.   - Hank Leukart / Matt Fell for the Doom Specs
  31.   - Vladimir (Wladows) Arnost, QA-Software (xarnos00@dcse.fee.vutbr.cz)
  32.     for the MUS-player
  33.   - DJ Ski for the nice asm-listing of DoomView
  34.     I can't get it working with NWT ;( - but I'm working on it.
  35.  
  36.   NWT is  completely  written  in  plain  Turbo C  with a lot  of assembly
  37. routines. The  GIF save/load routines  are taken  from a SimTel CD, author
  38. unknown. The MUS-player  is written  by Vladimir Arnost. No other parts of
  39. the source were taken from other programs.
  40.   NOTE: NWT will not be converted for any other system. Get DeuTex & DeuSF
  41. if using  another  system. If you  prefer  batch-wad-editing  try  DeuTex,
  42. DMGraph or DMaud.
  43.  
  44.   THIS VERSION DOES NOT WORK WITH SHAREWARE-DOOM/HERETIC ANYMORE!
  45.  
  46.  
  47. Description
  48. --------------------------------------------------------------------------
  49.   With NWT you got a very  powerful tool in your hands. NWT will offer you
  50. the following things to do with your Doom, Doom 2 or Heretic WADs:
  51.  
  52. - extract (export) any  kind of resource  saving it to GIF, PCX, WAV, VOC,
  53.   RAW or WAD (PWAD) files
  54. - insert (import) any kind of resource from GIF, PCX, VOC, WAV or RAW into
  55.   IWAD, PWAD or RAW files
  56. - view  any graphic-resources in standard VGA 320x200x256 or as  hex dump,
  57.   play any sound resource through a SoundBlaster (or compatible) soundcard
  58. - play any existing MUS-data in your WAD-file through AdLib-FM compatible
  59.   soundcards (including Soundblaster Pro stereo)
  60. - edit or add new texture patches, includes  editing PNames resource, save
  61.   it to WAD, RAW or TXT files (for compatibility to DeuTex :)
  62. - if you change  sprites or flats, you must pack all sprites/flats in your
  63.   PWAD - NWT will do it for you (replaces DMADDS/F & DeuSF)
  64. - another way using Sprites & Flats: merge your PWAD into your IWAD
  65. - open any WAD (PWAD) file and extract (export) all resources you want for
  66.   your own PWAD file
  67. - WAD cleaner - due to the use of tools (also NWT), a WAD file may contain
  68.   useless stuff - NWT will rewrite your WAD (IWAD or PWAD)
  69. - all features possible with every version of Doom & Doom 2 !
  70.  
  71.   All features should work with Heretic too. Heretic and Doom are using a
  72. different palette. The setup allows you to choose the palette. Also, both
  73. games are using different instrument setups! You have to save the resource
  74. GENMIDI from the Heretic-WAD to hear the original Heretic sound...
  75.  
  76.   Finally, you'll never need any other tool, except a level editor of your
  77. choice to make new levels. :-)
  78.  
  79.   With NWT you can view a few resources of Rise Of The Triad too! But don't
  80. be disappointed - only a few pics with the wrong palette.
  81.  
  82.  
  83. Requirements
  84. --------------------------------------------------------------------------
  85.   NWT is a DOS program, you  don't need Wind*ws to  run it. It should work
  86. on any machine Doom runs on (in Dos). I can't guarantee that NWT will work
  87. on your computer, but it works  well on my 486. You need at  least 480k of
  88. free memory to run it and a mouse is and will NOT be supported.
  89.   If you use the  arrows it is probably a bit slow because of checking and
  90. displaying  resource data  on the  screen. Norton's SPEEDISK makes great
  91. improvements as does cache-memory.
  92.   The  menu  idea  is taken  from 'Wad Tools 1.00' by  Jeff Miller. (never
  93. updated I think). First I wanted a tool like this but it became monstrous.
  94.  
  95.   At least basic knowledge of the structur of WAD files is required.If you
  96. don't know how to add a PWAD to Doom, how to use  sprites in PWADs or even
  97. what a resource is - stop here and read the Doom Specs first.
  98.  
  99.  
  100. Setup
  101. --------------------------------------------------------------------------
  102.   After the first start NWT will prompt you to setup the program. Just use
  103. the  cursor keys to  change the  configuration. Press RETURN to  save your
  104. changes. ESCAPE ends without saving keeping the current settings.
  105.  
  106.   Don't forget to choose the palette - Doom or Heretic?
  107.  
  108.   Remember: 'Primary graphic output file' means  that NWT will give  you a
  109. filename with this  extension. If you set it to GIF now and you want a PCX
  110. later, just type a  filename with this extension later. NWT will check the
  111. extensions to get the format used.
  112.   Sometimes it is useful to  have a  window and the  original palette when
  113. viewing graphic resources. If you want it, just move the X to YES.
  114. You can  edit the  setup anytime you  wish. Just press ALT-S or delete the
  115. file NWT.CFG before starting NWT.
  116.   If you want to  hear some MUS-files, be sure  to copy GENMIDI.OP2 in the
  117. same directory!
  118.  
  119.  
  120. Using NWT
  121. --------------------------------------------------------------------------
  122.   You  can  use NWT in  menu mode or  batch mode. Some  functions  are not
  123. available in  batch mode, others are not in  menu mode. See section 'Batch
  124. mode commands' for  details. To use  menu mode, just start NWT without any
  125. parameters.
  126.   At the  first view, NWT seems  to be a  bit confusing... Try it  and you
  127. will know how easy it is. If you  can't get it, print out 1STSTEPS.DOC and
  128. follow the instructions to see how it works.
  129.  
  130.  
  131. Viewing graphic and playing sound resources
  132. --------------------------------------------------------------------------
  133.   To view a  graphic resource or  play a voice resource through the output
  134. device  SoundBlaster , just  push RETURN. NWT will  check the  resource to
  135. get the type of it. You  can't view any  non-graphic  resources. You can't
  136. play the speaker sound resources (DPxxxxxx). To view a hex dump of it just
  137. type F1 and use the arrows to move.
  138.   With version 1.2 you can also  play the MUS-sound-resources through your
  139. AdLib-FM  compatible  soundcard (including  SoundBlaster Pro stereo). Just
  140. type RETURN to play a song, then press ESC to stop it or SPACE to play the
  141. music in background while editing your WAD-file.
  142.   If you want detailed information about the MUS-player, e-mail the author
  143. Vladimir (Wladows) Arnost, QA-Software.
  144.  
  145.   If you play some  voice resources while  music is playing in background,
  146. the quality of the voice output is lower, because of timer problems.
  147.  
  148.   Btw:the SoundBlaster base address MUST be 220h or 240h for voice output.
  149.  
  150.  
  151. Extracting resources (export)
  152. --------------------------------------------------------------------------
  153.   To  extract a  single resource to a RAW file, just  choose the  resource
  154. with  the Up & Down  arrows and  push F2. You  can change  the name of the
  155. output file or just press RETURN to confirm.
  156.   If you  want more than one resource  to extract, mark the resources with
  157. SPACE and finally push F2. NWT will now extract all marked resources. Push
  158. SPACE again to unmark a single resource or press F10 to  unmark all marked
  159. resources.
  160.   To extract  resources to GIF/WAV files, type F3 - NWT will check for the
  161. type of every single resource (if more than one).
  162.   To extract  to a PWAD file type F4 - if the PWAD file already exist, NWT
  163. will  always APPEND resources  not existing  in  the PWAD. If  a  resource
  164. already exist in it, NWT will overwrite it leaving the old one in it!
  165. Right, the  old one is useless, but writing  everytime the hole PWAD takes
  166. a lot of  time. If you got all  resources you  want in it,  just CLEAN the
  167. PWAD with NWT. (Btw: Dmgraph & Dmaud are doing it mostly the same way)
  168.   To save to a new PWAD, change the name or delete the old one.
  169.  
  170.  
  171. Inserting resources (import)
  172. --------------------------------------------------------------------------
  173.   There are three ways of inserting resources:
  174.    - Insert into existing IWAD (opened DOOM.WAD or alternate PWAD)
  175.    - Insert into existing/new PWAD(s)
  176.    - Insert with saving to RAW
  177.  
  178.   Again, seems to be a bit confusing but it is very useful.
  179.  
  180.   If you  got a resource  as a RAW file and you want it to be a PWAD file,
  181. just type F6 and  change or confirm  the given name. Done. NWT will append
  182. PWAD files the same way described above.
  183.  
  184.   It works the same way with inserting GIF & WAV. Key commands are as
  185. follows:
  186.  
  187.    F5 - Import RAW file into IWAD (changing your DOOM.WAD)
  188.    F6 - Import RAW file into PWAD (append/overwrite if exist)
  189.    F7 - Import GIF/WAV into IWAD, NWT will check type by extension
  190.    F8 - Import GIF/WAV into PWAD
  191.    F9 - Import GIF/WAV to RAW, just converting GIF/WAV to RAW
  192.  
  193.   If you write a  resource into the main IWAD file, NWT will check for the
  194. new and old length  of it, smaller  resources will  be overwritten, larger
  195. will be appended at the end of the file. (just like Dmgraph & Dmaud)
  196.   If you insert a resource from a GIF or PCX file, the size of it is taken
  197. from the  original resource! (you  don't have to  save your  graphics with
  198. the  correct size, but you MUST  save your new  graphic in the  upper left
  199. corner!) - but you can  change the size and offsets  after typing the name
  200. of the file. To make it a bit more confusing, you can only enter new sizes
  201. and offsets if you are inserting single resources.
  202.   (This will  probably  change in  future versions.  Let me  know what you
  203. think!)
  204.   NOTE: If you want to  insert a new WAV or VOC file, they MUST have 11025
  205. samples per second! Convert it with your sound-editor before inserting.
  206.  
  207.  
  208. Editing Textures
  209. --------------------------------------------------------------------------
  210.   This is a  very nice feature of NWT. You can edit old texture-patches by
  211. overwriting them. Also you can edit completely new patches, with new names
  212. and use them in Doom or in DEU too!
  213.   You can  save the  new texture  data as  RAW, WAD or TXT files. TXT is a
  214. very plain method  of DeuTex to  edit new textures. You can  use DeuTex to
  215. generate the new data for Doom. (but why?)
  216.   To edit a  new texture-patch, you must find the texture resource in your
  217. Doom IWAD first. In Doom there are two of them, TEXTURE1 for the shareware
  218. version and TEXTURE2 for the walls used in the registered version. To find
  219. them in the  resource list of NWT, just type ALT-T or type the word 'text'
  220. and NWT will search for it. Choose the one you want (in Doom 2 is only one
  221. texture resource) and push RETURN.
  222.   NWT will  now show a list of all texture-patches defined in this texture
  223. resource. Press RETURN to  view one, F1 to list the  used  patches  in the
  224. active texture-patch.
  225.   To  edit a texture-patch  type F2, confirm the given name or enter a new
  226. one. Then confirm or enter the output filename. NOTE: the extension deter-
  227. mines the format to save. The next important parameter is the size of your
  228. texture patch. Don't  use  any  exotic size, normal  textures are 256x128,
  229. 64x64, 64x128... The  largest texture may be 256x128. Avoid  odd numbers!!
  230. The  sum of the  sizes of all  wall patches used  must be <= 64k. NWT also
  231. limits the  maximum of used  patches to 64. This  is the  maximum used  in
  232. Doom & Doom 2.
  233.   After you  entered the size, NWT will list all PNAMES. Doom  allows only
  234. graphic  resources  for texture  patches  listed  in  this PNAMES-list. Of
  235. course you could put all  graphic resources in  this list, but this is not
  236. very usefull. Now you can  mark all PNames you  want for your  new texture
  237. patch. NWT will display the name of a texture using this PName so  you can
  238. easily  choose them  without viewing all PNames. (Because these PNames are
  239. the  resource-names  they are  not called CEMENT or GRAY, mostly  they are
  240. called WALLxxx, not giving any idea of their type).
  241.   After you marked all PNames you want, type F2 again. Now you are able to
  242. edit the texture patch. Simply  push SPACE to add a patch to your texture.
  243. NWT will switch to  graphics mode and you can place the patch wherever you
  244. want. Press RETURN to confirm or escape to abort placing the patch.
  245.   Back in  textmode you can  view your texture (F2), list the patches used
  246. so far (F1) or clear the hole patch (F3), if you don't like it. Push SPACE
  247. to  add another patch, save the texture  with F10 or press ESCAPE to abort
  248. editing.
  249.   If you  save the texture, NWT will read the hole  texture data from  the
  250. output file (if existing) and overwrite it with your changes. This way you
  251. can edit a lot of new textures saving them in the same file. Of course you
  252. can edit the same texture many times, overwriting it everytime. :)
  253. If you  save every texture patch in a  single file you will NOT be able to
  254. combine them to  one texture resource! (You can't add two PWADs containing
  255. the same resource to Doom or DEU - one will overwrite the other.)
  256.  
  257.   That's all about texture editing. Trial and error is the  best method of
  258. learning it! :)
  259.  
  260.  
  261. Viewing/Editing PNames resources
  262. --------------------------------------------------------------------------
  263.   Every Doom IWAD needs this  resource. It's a list of wall patches, which
  264. are used in textures  resources. For more information read the Doom Specs.
  265.   With NWT you are able to edit this list; editing means adding & deleting
  266. objects (resources). To view/edit  the PNames  list, press ALT-P. Type RET
  267. to view a resource, F2 to  add pnames or F3 to delete pnames. You can mark
  268. more than one pname and delete them all by pressing F3.
  269.   NOTE: If you are a lucky guy trying to  irritate Doom - just delete some
  270. of the pnames and  start Doom. All other people - don't try to delete some
  271. of the given pnames. This function is implemented only for deleting pnames
  272. added by you.
  273.   Like saving  texture-resources, you  can't save  this pnames-list direct
  274. into the  main IWAD - better  save as a RAW file and  insert this RAW file
  275. later into your WAD.
  276.  
  277.  
  278. Using Sprites & Flats in PWADs
  279. --------------------------------------------------------------------------
  280.   If you want to use your own Sprites & Flats in your levels you have 3
  281. possibilities:
  282.  
  283.  1.  Save your pictures direct into the Doom (2) IWAD
  284.      --> 'destroys' your IWAD, very slow
  285.  2.  Put your pictures into PWADs and add ALL other sprites to it using
  286.      NWT, DEUTEX or DMADDS
  287.      --> slow, takes a lot of disk space
  288.      --> but keeps your IWAD unchanged
  289.  3.  Merge your PWAD (including only resources you really want to change)
  290.      to your Doom/Heretic main IWAD
  291.  
  292.   The last choice is the  easiest and  fastest way to use Sprites & Flats.
  293. You can have  any other resources in your PWAD too - no problem. Alas, NWT
  294. will  change the IWAD  a bit. But with NWT it is  possible to restore your
  295. IWAD anytime you want.
  296.  
  297. [History...]
  298.   A few days ago I received a  Grenade/Crossbow patch. I was wondering how
  299. they used  to change the weapons  without any tool... they just 'replaced'
  300. some resources  not existing in  the IWAD.  Mmmmhhh...  Then I  tried some
  301. ideas with  the Doom IWAD and it  worked great. I think DeuTex is doing it
  302. nearly  the same  way... That's  why I used the  DeuTex-commands  -merge &
  303. -restore.
  304.  
  305.   After using the NWT -merge command you always have to add your PWAD when
  306. starting  Doom (2) or Heretic.  If you want to run  Doom without your PWAD
  307. you have  to restore  Doom first. Both  functions are only  changing a few
  308. bytes in your main IWAD - therefore it is very fast and safe!
  309.  
  310.  
  311. Working with PWADs
  312. --------------------------------------------------------------------------
  313.   With NWT  you  can  view  the  resource  directory  of any PWAD. You can
  314. extract single or all resources to  other PWADs (appending them) or export
  315. them for  editing (GIF, WAV). Also, you  can  load a PWAD and  delete  all
  316. resources you  want. Simply type '-' to  delete a resource.  Of course all
  317. marked resources will be deleted. I decided to use this key, because it is
  318. a very dangerous function.
  319.  
  320.   To open a PWAD type ALT-L.
  321.  
  322.   NOTE: NWT will NOT delete the resources, it will change the directory of
  323. the  opened PWAD. After  deleting  some  resources, I recommend  using the
  324. batch command -c (WAD-cleaner).
  325.  
  326.   Please use PWADs only with authors agreement!
  327.  
  328.   If you load a PWAD, it will be named as the active IWAD file, this means
  329. if you  save any  resource  into IWAD now, it will  be  written  into your
  330. opened PWAD. Of course your PWAD is still a PWAD file.
  331.  
  332.  
  333. Batch mode commands
  334. --------------------------------------------------------------------------
  335.   Now I will list all parameters available at the command line for NWT.
  336.  
  337. * NWT -file wadfile.wad
  338.   Will force NWT to load an alternate WAD file. The WAD file is now called
  339.   IWAD, because it replaces the (normally loaded) DOOM.WAD file. Of course
  340.   it is not really a IWAD file. With this option you can edit several WAD
  341.   files without having any Doom version installed.
  342.   NOTE: If you like to edit new textures in this kind of IWAD files, they
  343.   must contain the TEXTURE & PNAMES resource! Of course all P-resources
  344.   (wall patches) are needed! (So, better edit new textures having your
  345.   DOOM.WAD loaded :)
  346. * NWT -c wadfile.wad
  347.   Will rewrite any WAD file completely. Because after using tools
  348.   (including NWT) there may be unused stuff in WADs. Can take a while.
  349.    e.g. NWT -c doom.wad
  350. * NWT -as wadfile.wad
  351.   Will add all sprites not existing in your wad. If you got no sprite
  352.   resources in your PWAD, NWT will export all sprite resources.
  353.   You can have any other resources in your PWAD too. It doesn't matter.
  354.   Of course there must be a Doom IWAD in the same directory.
  355.    e.g. NWT -as mywad.wad
  356. * NWT -af wadfile.wad
  357.   The same as above but flats (floor & ceiling textures).
  358.    e.g. NWT -af thesame.wad
  359. * NWT -merge wadfile.wad
  360.   This command will  merge a PWAD (wadfile.wad) to your Doom IWAD. Anytime
  361.   you wish you can restore your IWAD; you don't need  the PWAD to  restore
  362.   the IWAD file. This is a  very safe  way to use  Sprite & Flats (and all
  363.   other resources of course) with Doom.
  364.   See section 'Using Sprites & Flats in PWADs' for detailed information.
  365. * NWT -restore
  366.   Will restore  your IWAD anytime  you want. NWT will  check the  file, so
  367.   restoring without 'merging' is impossible.
  368.  
  369.  
  370. Versions, Changes, Bug fixes
  371. --------------------------------------------------------------------------
  372. Version 1.0ß, 11/14/94
  373.  * Initial release
  374.  
  375. Version 1.1, 11/20/94
  376.  + Various little bugs fixed
  377.  + Dmgraph-GIF-bug fixed (because dmgraph adds unused extra stuff to GIFs)
  378.  + Better editing of filenames
  379.  + Added directory display (can display a maximum of 1500 files/dir !)
  380.  + Directory sort by NAME or DATE - default settings in setup
  381.  + New feature: editing PNames resources
  382.  + New feature: deleting resources from your opened WAD, very useful :)
  383.  + NWT now remembers the name of the last texture file & the last PWad
  384.    file edited
  385.  + Speed up (file in-out functions)
  386.  + More free memory for resources (see Restrictions)
  387.  - Speaker sound output does not work anymore due to change of memory
  388.    model, maybe in future versions
  389.  
  390. Version 1.2, 1/6/95
  391.  + Little WAV/VOC-save bug fixed (those shitty little bugs...argh)
  392.  + New feature: added MUS-play routine - thanks to V.Arnost, great work!
  393.  + New feature: renaming resources is now possible (ALT_R)
  394.  + New feature: Merge a PWAD into your IWAD, see 'Using Sprites & Flats'
  395.  + Added DOS Shell; there is not much memory left, but it may be useful
  396.  + Tricky VILE-filename bug fixed (replaces [\] with 123)
  397.  * This version does not work with Shareware-Doom anymore, hopefully!
  398.  + Detailed info about LMP-demos, you can view the textmode-resources too
  399.  + Soundblaster Base address (for voice output) is now adjustable
  400.    (220h or 240h)
  401.  * Added HERETIC support. All features should work. NWT will NOT work
  402.    with shareware Heretic!
  403.  
  404. Version 1.2a, 1/8/95
  405.  * Only a new e-mail address!
  406.  
  407.   If you received an updated version of NWT, be sure to delete NWT.CFG
  408. before starting NWT!
  409.  
  410.  
  411. Restrictions, Error Codes, Known bugs, Future plans
  412. --------------------------------------------------------------------------
  413.   This version of NWT is restricted as follows:
  414. Saving to PWAD allows a maximum of 3500 resources, the Doom or Doom 2 IWAD
  415. file may contain a maximum of 3500 resources, 500 PNames and 500 Textures.
  416. (in one texture resource).
  417.  
  418.   Error #2 means: No DOOM.WAD, DOOM2.WAD or HERETIC.WAD found. Copy NWT in
  419. your Doom/Heretic directory or use the command -file.
  420.   Error #3 means: Not enough memory. Kill some TSR's, free your memory.
  421. I think 480k free memory should be enough to run NWT.
  422.  
  423.   GENMIDI.OP2 is the instrument file used by the MUS-player. Don't forget
  424. to copy this file into your NWT directory!
  425.   If you are missing this file, export the resource GENMIDI as a RAW-file
  426. and rename it to GENMIDI.OP2.
  427.  
  428.   With NWT you can view a few resources of Rise Of The Triad too! But don't
  429. be disappointed - only a few pics with the wrong palette.
  430.  
  431.   Future plans? I think NWT has all functions you need. Anyway, if you got
  432. some really good ideas...
  433.   I don't think I will add further support for ROTT - it's not that good,
  434. to much problems (Apogee's WAD is not really a WAD) - so, only if enough
  435. people want me to do it.
  436.  
  437.   I received only a few mails since last version, so:
  438.  
  439. --> What do you think? Do you like it? Not?
  440. --> Any ideas? Comments? Suggestions? Bug reports? Let me know!
  441.  
  442.   If you want to rewrite this document (my english is beschissen... :) )
  443.   e-mail me and go on!
  444.  
  445.   Btw: Please upload this program wherever you are on. Thanks.
  446.  
  447.  
  448.  (c) 1/95 Denis Möller, TiC
  449.      denis@doomsday.shnet.org
  450.      BBS: Error +49-4351-2796, login as gast/gast (guest)
  451.